Skip to content

Added Codecov#6

Merged
jamius19 merged 8 commits into
mainfrom
feature/add-ci-badge
Jun 12, 2026
Merged

Added Codecov#6
jamius19 merged 8 commits into
mainfrom
feature/add-ci-badge

Conversation

@jamius19

@jamius19 jamius19 commented Jun 12, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation

    • Added a CI status badge to the README header for clearer project health at a glance.
  • Chores

    • CI now runs push workflows only on main while still testing pull requests.
    • Test runs collect coverage and upload reports for better visibility.
    • Coverage reporting enhanced to include lcov output alongside existing formats.

@jamius19 jamius19 self-assigned this Jun 12, 2026
@jamius19 jamius19 added the documentation Improvements or additions to documentation label Jun 12, 2026
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d2f4f761-b9bd-43f4-9c7c-9edef1bdf5c4

📥 Commits

Reviewing files that changed from the base of the PR and between 26a2643 and 794e383.

📒 Files selected for processing (3)
  • .github/workflows/ci.yaml
  • README.md
  • vitest.config.ts
✅ Files skipped from review due to trivial changes (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/ci.yaml

📝 Walkthrough

Walkthrough

Refines the GitHub Actions workflow triggers to restrict push to main, replaces the test step with a coverage run and Codecov upload, adds a CI status badge to the README, and adds lcov to Vitest coverage reporters.

Changes

CI updates

Layer / File(s) Summary
Workflow trigger mapping
.github/workflows/ci.yaml
The workflow on trigger was changed to push on main and pull_request (unfiltered).
Coverage run and Codecov upload
.github/workflows/ci.yaml
CI steps changed to run pnpm test:coverage and added a Codecov upload step using codecov/codecov-action pinned to a commit SHA with secrets.CODECOV_TOKEN and slug: postapsis/sibyl.
README CI status badge
README.md
Added a sibyl CI Status GitHub Actions workflow status badge referencing actions/workflows/ci.yaml.
Vitest lcov reporter
vitest.config.ts
Vitest test.coverage.reporter now includes lcov alongside text and html.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • postapsis/sibyl#5: Adds the GitHub Actions CI workflow (ci.yaml) that this PR updates and exposes via a README badge.

Suggested labels

enhancement

Poem

🐰 A tiny badge peeks from README's fold,
Coverage hops in, uploads to Codecov bold,
Pushes watch main, PRs still play,
The rabbit nods as checks relay,
Green lights glow — a merry fold.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Added Codecov' accurately summarizes the main objective of the PR, which is to integrate Codecov coverage reporting.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/add-ci-badge

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install timed out. The project may have too many dependencies for the sandbox.


Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 5: Update the badge alt/link text in README.md by replacing the
misleading "[![sibyl License Page](...)](...)" label with an accurate
description such as "[![sibyl CI status](...)](...)" (or "sibyl CI status
badge") so the image alt text and link text correctly reflect that this is a CI
status badge rather than a license page; locate the markdown snippet containing
[![sibyl License
Page](https://github.com/postapsis/sibyl/actions/workflows/ci.yaml/badge.svg)](https://github.com/postapsis/sibyl/actions/workflows/ci.yaml)
and change the visible/alt text accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f98f722d-618e-4178-bc58-5bb1725b9314

📥 Commits

Reviewing files that changed from the base of the PR and between bd8cee2 and 2b70f32.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
@jamius19 jamius19 added enhancement New feature or request and removed documentation Improvements or additions to documentation labels Jun 12, 2026
Added `lcov` reporter to test coverage configuration
@codecov

codecov Bot commented Jun 12, 2026

Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.github/workflows/ci.yaml (1)

2-2: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Update the workflow description to reflect the new trigger scope.

The comment states the workflow runs "every time a commit is pushed," but the trigger now limits push events to the main branch only. Consider updating the comment to reflect this.

📝 Proposed fix
-# Lints and tests sibyl every time a commit is pushed to the remote repository.
+# Lints and tests sibyl on pushes to main and on all pull requests.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/ci.yaml at line 2, Update the workflow header comment to
match the actual trigger scope: change the sentence "Lints and tests sibyl every
time a commit is pushed to the remote repository." to indicate that it runs on
pushes to the main branch only (or the specific branch listed in the workflow),
so the comment accurately reflects the push trigger restriction in the CI
workflow definition.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/ci.yaml:
- Line 30: Update the Codecov GitHub Action reference to an immutable commit
SHA: replace the mutable tag "codecov/codecov-action@v5" (the uses entry for the
Codecov action) with the pinned commit
"codecov/codecov-action@04b047e8bb82a0c002c8312c1c880fbc6a999d45" so the
workflow uses the exact immutable revision.

---

Outside diff comments:
In @.github/workflows/ci.yaml:
- Line 2: Update the workflow header comment to match the actual trigger scope:
change the sentence "Lints and tests sibyl every time a commit is pushed to the
remote repository." to indicate that it runs on pushes to the main branch only
(or the specific branch listed in the workflow), so the comment accurately
reflects the push trigger restriction in the CI workflow definition.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5f894923-64a2-452b-a9a1-4f161b905066

📥 Commits

Reviewing files that changed from the base of the PR and between 2cb48c7 and 26a2643.

📒 Files selected for processing (1)
  • .github/workflows/ci.yaml

Comment thread .github/workflows/ci.yaml Outdated
@jamius19 jamius19 changed the title Added CI status badge to README.md Added Codecov Jun 12, 2026
@jamius19 jamius19 merged commit efc305e into main Jun 12, 2026
3 checks passed
@jamius19 jamius19 deleted the feature/add-ci-badge branch June 12, 2026 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant